Skip to content

add new AsciiDocDITA rules - #21

Merged
jdkato merged 2 commits into
vale-cli:masterfrom
jldohmann:asciidoc-dita-rules
Aug 26, 2026
Merged

add new AsciiDocDITA rules#21
jdkato merged 2 commits into
vale-cli:masterfrom
jldohmann:asciidoc-dita-rules

Conversation

@jldohmann

Copy link
Copy Markdown
Contributor

this PR adds a new AsciiDocDITA rule set to the list of packages. this package attempts to find any AsciiDoc files that will not cleanly transform into DITA-compatible format so that writers can manually update those files for DITA compliance. it checks for things like the following:

  • Nested sections of content (error)
  • Proper content type definitions (warning)
  • Cross references to files outside of the current document (warning)
  • Existence of page breaks (warning)
  • Lists all conditional statements in a file (suggestion)

and more

we want to enable this for the openshift-docs prow CI so that we can be sure writers are not introducing anything new that would prevent transformation to DITA formatting as they continue to work on content

@jdkato
jdkato merged commit 2574a05 into vale-cli:master Aug 26, 2026
@jdkato

jdkato commented Aug 26, 2026

Copy link
Copy Markdown
Member

Merged — sorry for the very long silence. I placed the entry in its
alphabetical slot (the file is order-checked) but it's otherwise as you
wrote it. Thanks for the patience, and for the package: it synced and
ran cleanly against my fixtures.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants